DescribeAllEntity
Description
call the DescribeAllEntity to obtain the list information of all assets, including asset group ID, asset name, etc.
Request Method
POST
Request Path
/apsara/route/aegis/DescribeAllEntity
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| InstanceName | string | wasdsfasfdasfds | server instance name. |
| Uuid | string | edc897d6-xxxxx-xxxxx-xxxxx-xxxxx | server uuid. |
| RequestId | string | 7E0618A9-D5EF-4220-9471-C42B5E92719F | request ID of the result. |
| InternetIp | string | 101.202.20.20 | external network IP address. |
| Ip | string | 10.0.0.183 | server IP. |
| EntityList | array | - | instance list. |
| IntranetIp | string | 10.10.10.10 | intranet IP address. |
| GroupId | integer | 281801 | group ID. |
Example
Successful Response example
{
"InstanceName":"wasdsfasfdasfds",
"Uuid":"edc897d6-xxxxx-xxxxx-xxxxx-xxxxx",
"RequestId":"7E0618A9-D5EF-4220-9471-C42B5E92719F",
"InternetIp":"101.202.20.20",
"Ip":"10.0.0.183",
"EntityList":"-",
"IntranetIp":"10.10.10.10",
"GroupId":"281801"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}
title: DescribeAllGroups
sidebar_position: 3
DescribeAllGroups
Description
call the DescribeAllGroups interface to query all server grouping information.
Request Method
POST
Request Path
/apsara/route/Sas/DescribeAllGroups
Request Parameters Common Parameters
| Name | Location | Type | Required | Sample value | Description |
|---|---|---|---|---|---|
| regionId | BODY | string | Yes | No sample value for this parameter. | region id |
| Lang | BODY | string | No | zh | the language type of the request and receive message. zh: Chinese en: English |
| version | BODY | string | No | 2016-01-01 | version of api |
Return data
| Name | Type | Sample value | Description |
|---|---|---|---|
| GroupName | string | test | server group name. |
| RequestId | string | 7E0618A9-D5EF-4220-9471-C42B5E92719F | request ID of the result. |
| Groups | array | No sample value for this parameter. | server grouping information. |
| Count | integer | 2 | the current page displays the number of data. |
| GroupFlag | integer | 1 | server grouping type. 0: default grouping 1: other groups |
| GroupId | integer | 8834224 | server group ID. |
Example
Successful Response example
{
"GroupName":"test",
"RequestId":"7E0618A9-D5EF-4220-9471-C42B5E92719F",
"Groups":"",
"Count":"2",
"GroupFlag":"1",
"GroupId":"8834224"
}
Failed Response example
{
"errorSample":
{
"resultCode":-1,
"resultMsg":"system error",
"result":null
}
}